/*
 * The MIT License
 *
 * Copyright (c) 2012 Red Hat, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.jenkinsci.plugins.externalscheduler;

import hudson.ExtensionPoint;
import hudson.model.AbstractDescribableImpl;
import jenkins.model.Jenkins;
import net.sf.json.JSONObject;

import org.kohsuke.stapler.StaplerRequest;

/**
 * @author ogondza
 */
public abstract class Scheduler extends AbstractDescribableImpl<Scheduler> implements ExtensionPoint {

    private static StateProvider stateProvider;

    /**
     * Get planner solution
     *
     * @return New assignments or null in case Scheduler can not reliably deliver any solution.
     */
    public abstract NodeAssignments solution();

    protected static StateProvider stateProvider() {

        if (stateProvider == null) {

            stateProvider = new AbstractCiStateProvider(Jenkins.getInstance());
        }

        return stateProvider;
    }

    public static abstract class Descriptor extends hudson.model.Descriptor<Scheduler> {

        @Override
        public Scheduler newInstance(final StaplerRequest req, final JSONObject formData) throws FormException {

            return req.bindJSON(clazz, formData);
        }
    }
}